keychain/Signin Metrics/SFTransactionMetric.h

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #if __OBJC2__
  25 #ifndef SFTransactionMetric_h
  26 #define SFTransactionMetric_h
  27
  28 #import <Foundation/Foundation.h>
  29
  30 @interface SFTransactionMetric : NSObject <NSSecureCoding>
  31
  32 /*
  33    abstract: creates a new SFTransactionMetric object
  34    uuid: iCloud sign in transaction UUID
  35    category: name of client subsystem.  This will be used as the category name when logging
  36 */
  37 - (instancetype)initWithUUID:(NSString *)uuid category:(NSString *)category;
  38
  39 /*
  40    abstract: log when a particular event occurs ex. piggybacking, restore from backup
  41    eventName: name of the event that occured
  42    arguments: dictionary containing a set of event attributes a subsystem wishes to log.
  43 */
  44 - (void)logEvent:(NSString*)eventName eventAttributes:(NSDictionary<NSString*, id>*)attributes;
  45
  46 /*
  47    abstract: call to time tasks that take a while (backup, wait for initial sync)
  48    eventName: name of the event that occured
  49    blockToTime: the block of code you wish to have timed
  50 */
  51 - (void)timeEvent:(NSString*)eventName blockToTime:(void(^)(void))blockToTime;
  52
  53 /*
  54    abstract: call to log when a error occurs during sign in
  55    error: error that occured during iCloud Sign in
  56 */
  57 - (void)logError:(NSError*)error;
  58
  59 /*
  60    abstract: call to signal iCloud sign in has finished.
  61  */
  62 - (void)signInCompleted;
  63
  64 @end
  65
  66
  67 #endif /* SFTransactionMetric_h */
  68 #endif